<!doctype html>
<html class="no-js">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
    <title>prop</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">    <script>var pathToRoot = "../../";</script>
    <script>document.documentElement.classList.replace("no-js","js");</script>
    <script>const storage = localStorage.getItem("dokka-dark-mode")
    if (storage == null) {
        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
        if (osDarkSchemePreferred === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    } else {
        const savedDarkMode = JSON.parse(storage)
        if(savedDarkMode === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    }
    </script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
    <div class="root">
<nav class="navigation" id="navigation-wrapper">
    <div class="navigation--inner">
        <div class="navigation-title">
            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
            <div class="library-name">
<a class="library-name--link" href="../../index.html">
                            assertk-project
                    </a>            </div>
            <div class="library-version">0.28.0
            </div>
        </div>
        <div class="filter-section" id="filter-section">
                <button class="platform-tag platform-selector common-like" data-active="" data-filter=":assertk:dokkaHtmlPartial/commonMain">common</button>
        </div>
    </div>
    <div class="navigation-controls">
        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
    </div>
</nav>
        <div id="container">
            <div class="sidebar" id="leftColumn">
                <div class="sidebar--inner" id="sideMenu"></div>
            </div>
            <div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="assertk::assertk.assertions//prop/assertk.Assert[TypeParam(bounds=[kotlin.Any?])]#kotlin.String#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//2143336096">
  <div class="breadcrumbs"><a href="../index.html">assertk</a><span class="delimiter">/</span><a href="index.html">assertk.assertions</a><span class="delimiter">/</span><span class="current">prop</span></div>
  <div class="cover ">
    <h1 class="cover"><span><span>prop</span></span></h1>
  </div>
  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":assertk:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="prop.html">P</a><span class="token operator">&gt; </span><a href="../assertk/-assert/index.html">Assert</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="prop.html"><span class="token function">prop</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">name<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">extract<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="prop.html">P</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../assertk/-assert/index.html">Assert</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">P</a><span class="token operator">&gt;</span></div><p class="paragraph">Returns an assert that asserts on the given property of the value.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":assertk:dokkaHtmlPartial/commonMain" data-filterable-set=":assertk:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>name</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The name of the property to show in failure messages.</p></div></div></div></div><div class="table-row" data-filterable-current=":assertk:dokkaHtmlPartial/commonMain" data-filterable-set=":assertk:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>extract</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The function to extract the property value out of the value of the current assert.</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">assertThat(person).prop("name", { it.name }).isEqualTo("Sue")</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="prop.html">P</a><span class="token operator">&gt; </span><a href="../assertk/-assert/index.html">Assert</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="prop.html"><span class="token function">prop</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">property<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property1/index.html">KProperty1</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="prop.html">P</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../assertk/-assert/index.html">Assert</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">P</a><span class="token operator">&gt;</span></div><p class="paragraph">Returns an assert that asserts on the given property.</p><p class="paragraph">Example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">assertThat(person).prop(Person::name).isEqualTo("Sue")</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":assertk:dokkaHtmlPartial/commonMain" data-filterable-set=":assertk:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>property</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Property on which to assert. The name of this property will be shown in failure messages.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="prop.html">R</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="prop.html">F</a><span class="token operator"> : </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="prop.html">R</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-callable/index.html">KCallable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">R</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="../assertk/-assert/index.html">Assert</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="prop.html"><span class="token function">prop</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">callable<span class="token operator">: </span><a href="prop.html">F</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../assertk/-assert/index.html">Assert</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="prop.html">R</a><span class="token operator">&gt;</span></div><p class="paragraph">Returns an assert that asserts on the result of calling the given function.</p><p class="paragraph">Example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">assertThat(person).prop(Person::nameAsLowerCase).isEqualTo("sue")</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":assertk:dokkaHtmlPartial/commonMain" data-filterable-set=":assertk:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>callable</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Callable on which to assert. The name of this callable will be shown in the failure messages.</p></div></div></div></div></div></div></div>
</div>
      <div class="footer">
        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
      </div>
            </div>
        </div>
    </div>
</body>
</html>

